/*
 * Copyright (c) 2017-2022 TIBCO Software Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You
 * may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License. See accompanying
 * LICENSE file.
 */
package org.apache.spark.sql

import org.apache.spark.sql.SampleDataFrameContract.ErrorRow
import org.apache.spark.sql.collection.MultiColumnOpenHashMap
import org.apache.spark.sql.sources.StatCounter

import scala.collection.mutable


trait SampleDataFrameContract {


  def registerSampleTable(tableName: String, baseTable: Option[String]): Unit

  def errorStats(columnName: String,
                 groupBy: Set[String] = Set.empty): MultiColumnOpenHashMap[StatCounter]

  def errorEstimateAverage(columnName: String, confidence: Double,
                           groupByColumns: Set[String] = Set.empty): mutable.Map[Row, ErrorRow]
}

object SampleDataFrameContract {
  final type ErrorRow = (Double, Double, Double, Double)
}
